home *** CD-ROM | disk | FTP | other *** search
/ NetNews Offline 2 / NetNews Offline Volume 2.iso / news / comp / lang / c-part2 / 11919 < prev    next >
Encoding:
Internet Message Format  |  1996-08-05  |  1.6 KB
  1. Path: EU.net!sun4nl!xs4all!usenet
  2. From: muaddib@xs4all.nl (Thomas van Gulick)
  3. Newsgroups: comp.lang.c
  4. Subject: Re: MY SORT DOESN'T QUICK!
  5. Date: 27 Mar 1996 17:12:58 GMT
  6. Organization: XS4ALL, networking for the masses
  7. Message-ID: <1209.6660T1091T1758@xs4all.nl>
  8. References: <4j2drs$q3r@dfw-ixnews3.ix.netcom.com> <199603271345.NAA21366@gis1>
  9. NNTP-Posting-Host: undiscovered.xs4all.nl
  10. X-Newsreader: THOR 2.22 (Amiga;TCP/IP) *UNREGISTERED*
  11.  
  12. >I would gently suggest that you are likely to get a lot more help with
  13. >your programming problems if the associated C source is commented properly.
  14. >To go a bit further, I would recommend that you document ALL of your code
  15. >AS YOU WRITE IT (hardly anyone goes back and comments code properly after it
  16. >is written).  It's the professional thing to do.
  17.  
  18. Do you REALLY think that is valuable for something so small?
  19. What I normally do is create an 'autodoc' comment for it, which is used
  20. on my system to comment all system routines. This I like a lot more, but
  21. this is just a personal opinion.
  22.  
  23. An autodoc entry looks like this:
  24.  
  25. /****** xconfig.library/CB_CloneConfigList *********************************
  26. *
  27. *   NAME
  28. *       <name>
  29. *
  30. *   SYNOPSIS
  31. *       <prototype and register specification>
  32. *
  33. *   FUNCTION
  34. *       <what it does>
  35. *
  36. *   INPUTS
  37. *       <arguments>
  38. *
  39. *   RESULT
  40. *       <result after calling>
  41. *
  42. *   EXAMPLE
  43. *       <example code>
  44. *
  45. *   NOTES
  46. *       <warning messages>
  47. *
  48. *   BUGS
  49. *       <known bugs>
  50. *
  51. *   SEE ALSO
  52. *       <references>
  53. *
  54. ****************************************************************************/
  55.  
  56. Thomas
  57. --
  58. http://www.xs4all.nl/~muaddib/mf/ (working on a METW card index!)
  59.  
  60.